pp108 : artifactSchema Property

artifactSchema Property

 


This property is used to display artifacts in an Artifact Viewer.

The schema provided is used to generate HTML from the XML nodes that are passed. The schema needs to be provided in the format shown below.

<artifact:schema xmlns:artifact ='http://schemas.cordys.com/eibus/artifact/1.0'>
	<artifact:id/>
	<artifact:name/>
	<artifact:title/>
	<artifact:description/>
	<artifact:icon/>
	<artifact:applicationDefinition/>
	<artifact:info/>
	<artifact:customProperties>
		<customProp1>property1</customProp1>
	</artifact:customProperties>
</artifact:schema>

You must mandatorily provide the namespace, which is used for all elements inside the artifact schema. The elements in the schema are as described below.

  • id: Mandatory. Refers to the resource that needs to be identified or accessed. For example, a resource on the Web is identified using URI. Also, the type and ID of an artifact are used (in an Artifact JavaScript class) to tag the artifact.
  • name: Refers to the name of the artifact.
  • description: Refers to the description of the artifact.
  • icon: Refers to the URL of the icon used for the artifact.
  • applicationDefinition: Refers to the application definition of the artifact.
  • title: Optional. Refers to the tooltip of the artifact.

    You can also provide custom properties for artifacts, which can be used with the arrangeBy() method of Artifact Viewer. Consider the following example that demonstrates the use of custom properties in artifact data.
    <webservices>
        <Application>
            <id>cordysweb</id>
            <url>http://www.cordys.com</url>
            <name>Cordys</name>
            <title>click here to open Process Platform website</title>
            <description>BOP</description>
        </Application>
        <property1/>
    </webservices>